AI Service > AI Fashion > Maker API Guide

• This guide describes APIs required to use the AI Fashion Maker service.

API Common Information

Prerequisites

• To use the APIs, you need an integrated project Appkey or a service Appkey.
  • We recommend you use an integrated project Appkey.
  • You can use an integrated project Appkey after creating it from the API security settings in the project settings page.
  • You can find a service Appkey in the URL & Appkey menu at the top of the Console.

Indexing Input File Information

• .jsonl and .csv file format encoded in utf-8 is supported.
  • For csv files, you need to fill in the actual data from the first line.
  • There should be no blank lines in the file.
• The maximum file size is 20MB, and the maximum number of documents allowed is 10,000.
• You can upload files up to 4 times per day, and the counting is reset every day at 00:00 Korean time.
• The maximum number of documents that can be indexed per Service ID is 100,000.

Request Common Information

• To use the APIs, security key authentication is required.

[API Domain]

Response Common Information

• The APIs responds with "200 OK" to all API requests. For more information on the response results, see Response Body Header.

[Response Body Header]

[Example of Success Response Body]

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    }
}

[Example of Failure Response Body]

{
    "header": {
        "isSuccessful": false,
        "resultCode": -40000,
        "resultMessage": "InvalidParam"
    }
}

API Contents

Indexing Request

• Provide the data to index.
• Analyze the first line of the provided file and check if there is a format error.
• If no error is found on the first line, the file enters a queue for indexing and is indexed according to the schedule.

File Data Format

Image Guide

• If the width and height of a fashion item in the image are both 20px or below, the item is not recognized.
• For more accurate recognition, the size of a fashion item needs to increase as the image size increases.
• For more accurate recognition, a fashion item needs to take up a larger portion in the image.
• Maximum size of image file: 5,000,000 bytes
• Supported image formats: PNG, JPEG, GIF
• If you specify the port directly in the image URL, only ports 80, 443, 10000-12000 can be used.

jsonl Example

{"product_id": "10001", "status": "enable", "name": "AAA red onepiece", "category1_id": "1", "category2_id": "1", "category3_id": "2", "image_url": "http://aaaaaaa.bbbbb.jpg", "s1": "1", "s2": "2"}
{"product_id": "10002", "status": "disable", "name": "BBB blue onepiece", "category1_id": "1", "category2_id": "1", "category3_id": "2", "image_url": "http://bbbbbbb.ccccc.jpg", "s1": "s1", "s2": "2"}
{"product_id": "10003", "status": "enable", "name": "BBB blue blouse", "category1_id": "1", "category2_id": "1", "category3_id": "3", "image_url": "http://bbbbbbb.ddddd.jpg", "s1": "", "s2": "s2"}
...

csv Example

10001,enable,AAA red onepiece,1,1,2,http://aaaaaaa.bbbbb.jpg,1,2
10002,disable,BBB blue onepiece,1,1,2,http://bbbbbbb.ccccc.jpg,s1,2
10003,enable,BBB blue blouse,1,1,3,http://bbbbbbb.ddddd.jpg,,s2
...

Request

• You can provide a data file by sending the file directly or providing a downloadable URL.

[URI]

[Path Variable]

[URL Parameter]

[Form Data]

curl -X POST "/nhn-ai-fashion-maker/v1.0/appkeys/{appKey}/service/{serviceID}/index?format=jsonl" -H "Content-Type: multipart/form-data" -F "file=@/home/user1/202106251000_product.jsonl"

curl -X POST "/nhn-ai-fashion-maker/v1.0/appkeys/{appKey}/service/{serviceID}/index?format=jsonl" -F "link=https://cdn.my-domain.com/202106251000_product.jsonl"

Response

• [Response Body Header description omitted]
  • This information is available in Response Common Information.

[Response Body Data]

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "data": {
        "indexID": "24bb94b3-8a6b-488e-b038-4f6038da2596"
    }
}

Error Codes

Service Information

• Check the current information of services.
  • Number of indexing left for each service
  • Number of indexed documents for each service

Request

[URI]

curl -X GET "/nhn-ai-fashion-maker/v1.0/appkeys/{appKey}/services" -H "Content-Type: application/json"

Response

• [Response Body Header description omitted]
  • This information is available in Response Common Information.

[Response Body Data]

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "data": {
        "totalService": 3
        "items": [
            {
                "service": "aaa",
                "remainInsertCnt": 3,
                "documentCnt": 51128
            },
            {
                "service": "bbb",
                "remainInsertCnt": 2,
                "documentCnt": 9778
            },
            {
                "service": "ccc",
                "remainInsertCnt": 0,
                "documentCnt": 29841
            }
        ]
    }
}

Error Codes

Indexing Status Query

• Check the current status of requested indexing.
• The maximum retention period for indexing status is 6 months from the registration time.

Request

[URI]

[Path Variable]

[URL Parameter]

Paging

• Paging can be performed with start and limit parameters.
  • start: Starts from 0.
  • limit: Must be higher than 0 and the maximum value is 100.
• The maximum number for paging is 1000.
  • Supported:
    • start: 900
    • end: 100
  • Not supported:
    • start: 901
    • end: 100
    • This is not supported because the number exceeds the maximum number for paging, 1000.

Sorting

• Sorting parameter of the response document
• Parameter format.
  • {Sort item}:{Sorting method}
• Sort item
  • reservedTime: Indexing request registration time
  • startTime: Indexing start time
  • finishTime: Indexing finish time
  • addCnt: Number of added documents
  • failCnt: Number of failed documents
  • deleteCnt: Number of deleted documents
  • updateCnt: Number of updated documents
  • totalCnt: Number of total documents
• Sorting method
  • asc: Ascending order
  • desc: Descending order

Indexing Status

• Indexing status value can be searched by conditions.
  • reserved: Pending
  • running: In-progress
  • failed: All failed
  • finished: Finished (including partially failed)

curl -X GET "/nhn-ai-fashion-maker/v1.0/appkeys/{appKey}/service/{serviceID}/indexes?start=0&limit=100&status=running&order=startTime:desc"  -H "Content-Type: application/json"

Response

• [Response Body Header description omitted]
  • This information is available in Response Common Information.

[Response Body Data]

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "data": {
        "total": 100,
        "items":[{
            "service": "testserviceid"
            "id": "24bb94b3-8a6b-488e-b038-4f6038da2596",
            "filename": "202106251000_product.jsonl",
            "status": "reserved",
            "reservedTime": 1627018935,
            "startTime": 1627018935,
            "finishTime": 1627018935,
            "addCnt": 234,
            "failCnt": 31,
            "deleteCnt": 31,
            "updateCnt": 592,
            "totalCnt": 888
        }]
    }
}

Error Codes